home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / utilities / _customise / clocks / _iconclok / _help < prev    next >
Encoding:
Text File  |  1992-05-07  |  3.6 KB  |  70 lines
  1. | > !Help for !IconClock
  2.  
  3.    This program displays a clock on the iconbar. The clock may be either a
  4. twelve or twenty four hour clock. The clock also has three types of clockface
  5. available. These are raised, lowered and border. The time format and
  6. clockface type can be selected from the iconbar menu and its submenus.
  7.  
  8.    To configure the program to your own favourite clock type you can use the
  9. system variable IconClock$Options. There are six (twelve) possible values of
  10. the variable. They are :-
  11.  
  12.         24R or 24r      24 hour clock, raised clockface (the default)
  13.         24L or 24l      24 hour clock, lowered clockface
  14.         24B or 24b      24 hour clock, border clockface
  15.         12R or 12r      12 hour clock, raised clockface
  16.         12L or 12l      12 hour clock, lowered clockface
  17.         12B or 12b      12 hour clock, border clockface
  18.  
  19.    When the iconclock is run the variable IconClock$Options is looked for. If
  20. it is isn't defined then the variable is defined to the default, of 24R. If
  21. it is defined it is checked for validity. If it is invalid an error window is
  22. displayed saying the the variable is invalid and has been replaced by the
  23. default. If it is valid then the desired clockface and time format are used.
  24.  
  25.    The iconclock is really a module which, once loaded, will start the clock
  26. each time the desktop is entered. The reason it is in an application
  27. directory is one so that you will hopefully read this file and two so that
  28. the icons required can be loaded into the wimp pool.
  29.  
  30.    If you have a harddisc there are two ways to run this application, either
  31. by making to application be run every time the desktop is started (see below
  32. for ways to do this if don't know how to), or by loading the sprites (see
  33. below for comment on this) and the module before the desktop is started.
  34.  
  35.    To start the application every time the desktop is started you can use
  36.                 *Desktop <full path>.!IconClock
  37.              eg *Desktop adfs::Disc4.$.Desk_Utils.!IconClock
  38.  
  39.    Or if you want to run more than one task upon startup you can use
  40.                 *Desktop -File <full path of file>
  41. where this file contains a sequence of commands to be run upon startup. So to
  42. run the iconclock you should include the line
  43.                 *Run <full path>.!IconClock
  44. somewhere in the file.
  45.  
  46.    If the module is loaded seperately (which is the preferable way to run
  47. this application) the sprite you plan to use for the clockface must be
  48. loaded. Note you only have to load the sprite for the clockface you want to
  49. use. So once you have decided which clockface you like best copy the sprite
  50. out of the !Sprites file in this application into a seperate file and
  51. *IconSprites this file in your !Boot file. Or I recomend you put it in the
  52. !Sprites of your !System directory and *Run this application in your !Boot
  53. file. I know this all sounds horribly technical but it is not an easy thing
  54. to explain (believe me). If you have only loaded some of the sprites then
  55. some of the menu entries on the clockface menu will be greyed (unselectable).
  56.    If the sprite for the clockface selected by the IconClock$Options variable
  57. is not in the wimp pool upon startup then an error message will be generated
  58. and the application will not startup.
  59.  
  60.    Although I have tested this program fairly thoroughly I offer no guarentee
  61. what so ever and accept no responsibility for any damage caused by its use or
  62. misuse.
  63.    This program is in the public domain and may be freely copied as long as
  64. no charges are made for it all the files are left unchanged. You may use the
  65. source of parts of it in your own programs as long I am credited.
  66.  
  67.         Yours,
  68.                 Pop Mobility Freak
  69.                 (Ian Ashley)
  70.